home *** CD-ROM | disk | FTP | other *** search
/ X User Tools / X User Tools (O'Reilly and Associates)(1994).ISO / sun4c / archive / tcltk.z / tcltk / man / cat3 / RegInterp.3 < prev    next >
Text File  |  1994-09-20  |  3KB  |  133 lines
  1.  
  2.  
  3.  
  4. Tk_RegisterInterp(3)  Tk Library Procedures
  5.  
  6.  
  7.  
  8. _________________________________________________________________
  9.  
  10. NAME
  11.      Tk_RegisterInterp -  make  an  interpreter  accessible  with
  12.      ``send'' command
  13.  
  14. SYNOPSIS
  15.      #include <tk.h>
  16.  
  17.      int
  18.      Tk_RegisterInterp(_i_n_t_e_r_p, _n_a_m_e, _t_k_w_i_n)
  19.  
  20. ARGUMENTS
  21.      Tcl_Interp  *_i_n_t_e_r_p  (in)      Interpreter  to  register  in
  22.                                     display    associated    with
  23.                                     _t_k_w_i_n.  Also used  to  return
  24.                                     errors     if    registration
  25.                                     failed.
  26.  
  27.      char        *_n_a_m_e    (in)      Name under which to  register
  28.                                     interpreter.   Must be unique
  29.                                     among all  registered  inter-
  30.                                     preters  for _t_k_w_i_n's display.
  31.                                     May not contain the character
  32.                                     ``|''.
  33.  
  34.      Tk_Window   _t_k_w_i_n    (in)      Token for window.  Used  only
  35.                                     to find a display in which to
  36.                                     register _i_n_t_e_r_p.
  37. _________________________________________________________________
  38.  
  39.  
  40. DESCRIPTION
  41.      Tk_RegisterInterp is invoked to associate a name (_n_a_m_e) with
  42.      a  Tcl interpreter (_i_n_t_e_r_p) and record that association in a
  43.      well-known property of a particular display  (the  one  con-
  44.      taining  _t_k_w_i_n).   After  this  procedure  has been invoked,
  45.      other interpreters in the display will be able  to  use  the
  46.      send  command  to invoke operations remotely in _i_n_t_e_r_p.  The
  47.      procedure returns TCL_OK if the registration completed  suc-
  48.      cessfully  and  TCL_ERROR  if  the  interpreter could not be
  49.      registered (e.g. because _n_a_m_e is already in  use).   In  the
  50.      event  of an error, _i_n_t_e_r_p->_r_e_s_u_l_t is modified to point to a
  51.      message describing the error.
  52.  
  53.      This procedure also adds a send command to _i_n_t_e_r_p,  so  that
  54.      commands may be sent from _i_n_t_e_r_p to other interpreters.
  55.  
  56.      The registration persists until the interpreter  is  deleted
  57.      or  the  send command is deleted from _i_n_t_e_r_p, at which point
  58.      _i_n_t_e_r_p is automatically unregistered.
  59.  
  60.  
  61.  
  62.  
  63. Tk                                                              1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. Tk_RegisterInterp(3)  Tk Library Procedures
  71.  
  72.  
  73.  
  74.      Tk_RegisterInterp     is     called     automatically     by
  75.      Tk_CreateMainWindow,  so applications don't normally need to
  76.      call it explicitly.
  77.  
  78.  
  79. KEYWORDS
  80.      interpreter, name, register, send command
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129. Tk                                                              2
  130.  
  131.  
  132.  
  133.